home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-06 / bt515.exe / BTOOLS / BSIM.HLP < prev    next >
Text File  |  1991-04-17  |  17KB  |  592 lines

  1.  
  2. ABOUT BSIM
  3. 22
  4.    This program allows you to execute most of the Btrieve operations directly
  5. without having to write your own program.
  6.  
  7.    This can be very helpful when you are just learning Btrieve as well as
  8. when you want to analyze how Btrieve operations affect the different
  9. parameters byte by byte.
  10.  
  11.    Also, it is very useful for trouble-shooting problems in your application
  12. program - i.e, if the same sequence of Btrieve calls can reproduce your
  13. problem, then you know that it is not a bug in your application.
  14.  
  15.    To open a file, just put the name of the file in the Key Buffer,
  16. choose Function 0 (open), and hit F1. Use the quick keys to access
  17. the Btrieve parameters and hit F1 to call Btrieve. Play around with
  18. the different operations; for example, choosing op 14 (create) allows
  19. you to easily create any kind of Btrieve file!  Have FUN!
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35. MAJOR FEATURES
  36. 22
  37. - Up to 20 files open and accessible at once. Detailed info on each file.
  38. - Viewing / editing facility for Data and Key Buffers as well as Position Block
  39.      You can view & edit these buffers in ascii AND hex simultaneously.
  40. - View, edit records up to 32K bytes long.
  41. - English status and error messages.
  42. - Create any Btrieve file via easy-to-follow prompts.
  43. - Perform extended btrieve operations via prompting.
  44. - View detailed statistics on files.
  45. - Create and Drop supplemental indices.
  46. - Shell to Dos feature.
  47. - Quick btrieve operation code reference.
  48. - Quick btrieve status code reference.
  49.  
  50. NEW Features:
  51. - Define a  permanent "data dictionary" of fields which allow you to easily
  52.       view & edit non-displayable data types (integers, dates, etc...).
  53. - Repeat a Btrieve operation as many times as you like with 1 keystroke.
  54. - Define "Macros"; these allow you to save a series of btrieve operations
  55.       on up to 20 files and play the operations back at will.
  56. - Startup Options   BSIM filename to open a file in Normal Mode
  57.                     BSIM @macroname to run a macro immediately
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76. DATA/KEY BUFFERS
  77. 17
  78. - When you choose Data or Key Buffer, you can see or edit all values
  79.   stored in the buffer. All displayable characters are shown in ascii,
  80.   while all values are displayed in hex below the ascii line.
  81.  
  82. - You can move right or left using arrows, tab, shift-tab, home, or end.
  83.   You can use the up and down arrows to move to the ascii or hex lines.
  84.  
  85. - When you change an ascii character, the hex values change. When you
  86.   change a hex value, the ascii value changes.
  87.  
  88. - If you position the buffer at, e.g. offset 300-380, hit return, and
  89.   do a get next, the next record will be displayed at that offset. This
  90.   makes it easy to scroll and view a certain area in each record.
  91.  
  92. - Use Alt-D to toggle the Display Hex mode. Use this if you only want to
  93.   look at the displayable characters in the buffer.
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104. MULTIPLE FILES
  105. 22
  106. This program provides great flexibility for doing multi-file simulations.
  107. You can have up to 20 position blocks allocated at once and each position
  108. block can use a different amount of memory. This is very useful if you
  109. need to access files with very large record sizes.
  110.  
  111. - Pos Blk 1 is already allocated for you.
  112.  
  113. - Go to Change position block screen to allocate or deallocate pos blks.
  114.   This just grabs memory off the heap to store data/key buffers and
  115.   various other  internal structures. User enters amount of heap space
  116.   to allocate for each position block. This allows you to access 1 file
  117.   with very large records and several other files with small records.
  118.  
  119. - Information regarding each position block and any file opened to that
  120.   block is on the screen, including filename, open mode, last operation
  121.   and status on that position block and maximum record length. This is
  122.   useful in keeping track of where you are in a complex multi-file test.
  123.  
  124. - If you shell out to Dos from the main menu, your position blocks are
  125.   still allocated and intact when you return.
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.  
  142.  
  143.  
  144. SPECIAL OPERATIONS
  145. 22
  146. Bsim allows you to perform many of the difficult Btrieve operations
  147. by, for example, prompting you for information to put in the data buffer
  148. for the CREATE operation. It also interprets information returned from
  149. Btrieve in, e.g. the STATUS operation. Here is a list of the operations
  150. which are are handled differently:
  151.  
  152.   - Create:  Put data in buffer 1st, then do the actual Create operation
  153.   - Create Supplemental Index:
  154.              Similar to create, just with key info
  155.   - Version: Give version of Btrieve loaded
  156.   - Stat:    Displays statistics from Stat operation in easy-to-read format.
  157.   - Extended Gets  {not implemented yet}
  158.              Will allow user to simulate filtering operations
  159.   - Extended Steps {not implemented yet}
  160.              Will allow user to insert a load file into their Btrieve file.
  161.  
  162. Note: As with all other operations, the Btrieve parameters are changed
  163.       as they would be in your program. You can see how Btrieve actually
  164.       modifies these parameters. This can be very useful when you are first
  165.       learning how to do, e.g. a Create operation. Enter the information
  166.       through prompts and then look at how the information is stored
  167.       in the data buffer.
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177. SUGGESTIONS / BUG REPORTS
  178. 6
  179.  
  180. Please direct all enhancement suggestions or bug reports to
  181.  
  182. David Garrison @ Novell  (DPD)
  183. 902 E. Live Oak
  184. Austin, TX  78704
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191. FIELDS FEATURE
  192. 20
  193.   This is the latest feature of BSIM. It allows you to view and edit
  194. formerly non-displayable data types. Currently, Bsim supports only
  195. the integer (short, word, and long)  and date types. In the future,
  196. it will support all commonly used non-displayable Btrieve extended
  197. data types.
  198.   To use Fields, simply go into the data buffer when a file is open,
  199. hit Alt-F and, if you havent defined fields for the file yet, it
  200. will put you into a screen which will allow you to easily define
  201. fields for that file.  Once this field file (filename.sim) is defined
  202. it can be reused.
  203.   Once the field file is read in, Bsim will show you which bytes in the
  204. record have fields defined onto them. As you scroll through the record
  205. the data type, position, length, and actual displayable value will
  206. be shown for each field that you have defined.
  207.   To edit a field, simply hit Alt-E, and you can edit the value in readable
  208. form. Hit return and it will be translated to binary form and put into
  209. the record buffer.
  210.   Besides supporting other data types in the data buffer in the future,
  211. Bsim will at some point also support editing key values (including segmented
  212. key values!)     Have fun with fields!
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243. DATA/KEY BUFFERS
  244. 17
  245. - When you choose Data or Key Buffer, you can see or edit all values
  246.   stored in the buffer. All displayable characters are shown in ascii,
  247.   while all values are displayed in hex below the ascii line.
  248.  
  249. - You can move right or left using arrows, tab, shift-tab, home, or end.
  250.   You can use the up and down arrows to move to the ascii or hex lines.
  251.  
  252. - When you change an ascii character, the hex values change. When you
  253.   change a hex value, the ascii value changes.
  254.  
  255. - If you position the buffer at, e.g. offset 300-380, hit return, and
  256.   do a get next, the next record will be displayed at that offset. This
  257.   makes it easy to scroll and view a certain area in each record.
  258.  
  259. - Use Alt-D to toggle the Display Hex mode. Use this if you only want to
  260.   look at the displayable characters in the buffer.
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271. POSITION BLOCKS
  272. 22
  273. This program provides great flexibility for doing multi-file simulations.
  274. You can have up to 20 position blocks allocated at once and each position
  275. block can use a different amount of memory. This is very useful if you
  276. need to access files with very large record sizes.
  277.  
  278. - Pos Blk 1 is already allocated for you.
  279.  
  280. - Go to Change position block screen to allocate or deallocate pos blks.
  281.   This just grabs memory off the heap to store data/key buffers and
  282.   various other  internal structures. User enters amount of heap space
  283.   to allocate for each position block. This allows you to access 1 file
  284.   with very large records and several other files with small records.
  285.  
  286. - Information regarding each position block and any file opened to that
  287.   block is on the screen, including filename, open mode, last operation
  288.   and status on that position block and maximum record length. This is
  289.   useful in keeping track of where you are in a complex multi-file test.
  290.  
  291. - If you shell out to Dos from the main menu, your position blocks are
  292.   still allocated and intact when you return.
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311. SPECIAL OPERATIONS
  312. 22
  313. Bsim allows you to perform many of the difficult Btrieve operations
  314. by, for example, prompting you for information to put in the data buffer
  315. for the CREATE operation. It also interprets information returned from
  316. Btrieve in, e.g. the STATUS operation. Here is a list of the operations
  317. which are are handled differently:
  318.  
  319.   - Create:  Put data in buffer 1st, then do the actual Create operation
  320.   - Create Supplemental Index:
  321.              Similar to create, just with key info
  322.   - Version: Give version of Btrieve loaded
  323.   - Stat:    Displays statistics from Stat operation in easy-to-read format.
  324.   - Extended Gets&Steps  Allows user to simulate filtering operations
  325.   - Extended Inserts {not implemented yet}
  326.              Will allow user to insert a load file into their Btrieve file.
  327.  
  328. Note: As with all other operations, the Btrieve parameters are changed
  329.       as they would be in your program. You can see how Btrieve actually
  330.       modifies these parameters. This can be very useful when you are first
  331.       learning how to do, e.g. a Create operation. Enter the information
  332.       through prompts and then look at how the information is stored
  333.       in the data buffer.
  334.  
  335.  
  336.  
  337.  
  338.  
  339.  
  340.  
  341.  
  342.  
  343. SUGGESTIONS / BUG REPORTS
  344. 6
  345.  
  346. Please direct all enhancement suggestions or bug reports to
  347.  
  348. David Garrison @ Novell  (DPD)
  349. 902 E. Live Oak
  350. Austin, TX  78704
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357. FIELDS FEATURE
  358. 20
  359.     This feature allows you to view and edit formerly non-displayable
  360. data types by allowing you to define a "data dictionary" of fields
  361. onto a file. Currently, Bsim supports only the integer, autoinc, date,
  362. and time data types. I will add other data types if requested.
  363.     To use Fields, simply go into the data buffer when a file is open,
  364. hit Alt-F and, if you havent defined fields for the file yet, it
  365. will put you into a screen which will allow you to easily define
  366. fields for that file.  Once this field file (filename.sim) is defined
  367. it can be reused. If you like, you can have Bsim create fields for all
  368. of the defined keys in the Btrieve file automatically. These key fields
  369. can then be used to do easy searches on keys.
  370.     Once the field file is read in, Bsim will show you which bytes in the
  371. record have fields defined onto them. As you scroll through the record
  372. the data type, position, length, and actual displayable value will
  373. be shown for each field that you have defined.
  374.     To edit a field, simply hit Alt-E, and you can edit the value in readable
  375. form. Hit return and it will be translated to binary form and put into
  376. the record buffer.
  377.  
  378.     Have fun with Fields!
  379.  
  380.  
  381.  
  382.  
  383. MACROS
  384. 20
  385.     This is the newest feature in Bsim. Basically, it allows you to
  386. store all Btrieve operations you make (on one or more files). This is
  387. especially useful if you perform a complex series of operations and will
  388. want to go back and reproduce it later for analysis, to pass on to testing
  389. or development, etc.....
  390.     It's quite easy to use macros. To record, simply enter the macro
  391. file name, the text to go at top of macro file.bmc, and the macro speed
  392. (1=fast, 10=slow). Then start doing btrieve operations as you normally
  393. would in Bsim. All necessary information is stored in a macrofile.bmc.
  394. If you would like the macro to pause when played at any point just hit
  395. F5. To end the macro, hit F6.  To play back, just enter the macro name
  396. and use either F1 (to play), F4 (to step), F5 (to pause) or F6 (to quit).
  397.     There are optional flags for macros which allow you to pause, change
  398. the speed, stop on an error, etc... (these will be included here as they
  399. are better defined)
  400.  
  401.  
  402.  
  403.  
  404.  
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.  
  412.  
  413.  
  414.  
  415.  
  416.  
  417.  
  418.  
  419.  
  420.  
  421.  
  422.  
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435. MAJOR FEATURES
  436. 23
  437. - Up to 20 files open and accessible at once. Detailed info on each file.
  438.      You can easily switch back and forth between all open files. You can
  439.      allocate the memory you need for each position block.
  440. - Viewing / editing facility for Data and Key Buffers as well as Position Block
  441.      You can view & edit these buffers in ascii AND hex simultaneously.
  442. - View, edit records up to 32K bytes long.
  443. - English status and error messages.
  444. - Create any Btrieve file via easy-to-follow prompts.
  445. - Perform extended btrieve operations via prompting.
  446. - View detailed statistics on files.
  447. - Create and Drop supplemental indices.
  448. - Shell to Dos feature.
  449. - Quick btrieve operation code reference.
  450. - Quick btrieve status code reference.
  451. NEW Features:
  452. - Define a  permanent "data dictionary" of fields which allow you to easily
  453.       view & edit non-displayable data types (integers, dates, etc...). Can
  454.       store existing key info as fields, allowing you to easily perform
  455.       searches on non-displayable data types.
  456. - Repeat a Btrieve operation as many times as you like with 1 keystroke.
  457. - Define "Macros"; these allow you to save a series of btrieve operations
  458.       on up to 20 files and play the operations back at will. This is
  459.       especially useful for saving a problem that you've reproduced for
  460.       analysis later.
  461.  
  462.  
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470.  
  471.  
  472.  
  473.  
  474.  
  475.  
  476.  
  477.  
  478.  
  479. DATA/KEY BUFFERS
  480. 17
  481. - When you choose Data or Key Buffer, you can see or edit all values
  482.   stored in the buffer. All displayable characters are shown in ascii,
  483.   while all values are displayed in hex below the ascii line.
  484.  
  485. - You can move right or left using arrows, tab, shift-tab, home, or end.
  486.   You can use the up and down arrows to move to the ascii or hex lines.
  487.  
  488. - When you change an ascii character, the hex values change. When you
  489.   change a hex value, the ascii value changes.
  490.  
  491. - If you position the buffer at, e.g. offset 300-380, hit return, and
  492.   do a get next, the next record will be displayed at that offset. This
  493.   makes it easy to scroll and view a certain area in each record.
  494.  
  495. - Use Alt-D to toggle the Display Hex mode. Use this if you only want to
  496.   look at the displayable characters in the buffer.
  497.  
  498.  
  499.  
  500.  
  501.  
  502.  
  503.  
  504.  
  505.  
  506.  
  507. POSITION BLOCKS
  508. 22
  509. This program provides great flexibility for doing multi-file simulations.
  510. You can have up to 20 position blocks allocated at once and each position
  511. block can use a different amount of memory. This is very useful if you
  512. need to access files with very large record sizes.
  513.  
  514. - Pos Blk 1 is already allocated for you.
  515.  
  516. - Go to Change position block screen to allocate or deallocate pos blks.
  517.   This just grabs memory off the heap to store data/key buffers and
  518.   various other  internal structures. User enters amount of heap space
  519.   to allocate for each position block. This allows you to access 1 file
  520.   with very large records and several other files with small records.
  521.  
  522. - Information regarding each position block and any file opened to that
  523.   block is on the screen, including filename, open mode, last operation
  524.   and status on that position block and maximum record length. This is
  525.   useful in keeping track of where you are in a complex multi-file test.
  526.  
  527. - If you shell out to Dos from the main menu, your position blocks are
  528.   still allocated and intact when you return.
  529.  
  530.  
  531.  
  532.  
  533.  
  534.  
  535.  
  536.  
  537.  
  538.  
  539.  
  540.  
  541.  
  542.  
  543.  
  544.  
  545.  
  546.  
  547. SPECIAL OPERATIONS
  548. 22
  549. Bsim allows you to perform many of the difficult Btrieve operations
  550. by, for example, prompting you for information to put in the data buffer
  551. for the CREATE operation. It also interprets information returned from
  552. Btrieve in, e.g. the STATUS operation. Here is a list of the operations
  553. which are are handled differently:
  554.  
  555.   - Create:  Put data in buffer 1st, then do the actual Create operation
  556.   - Create Supplemental Index:
  557.              Similar to create, just with key info
  558.   - Version: Give version of Btrieve loaded
  559.   - Stat:    Displays statistics from Stat operation in easy-to-read format.
  560.   - Extended Gets  {not implemented yet}
  561.              Will allow user to simulate filtering operations
  562.   - Extended Steps {not implemented yet}
  563.              Will allow user to insert a load file into their Btrieve file.
  564.  
  565. Note: As with all other operations, the Btrieve parameters are changed
  566.       as they would be in your program. You can see how Btrieve actually
  567.       modifies these parameters. This can be very useful when you are first
  568.       learning how to do, e.g. a Create operation. Enter the information
  569.       through prompts and then look at how the information is stored
  570.       in the data buffer.
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580. SUGGESTIONS / BUG REPORTS
  581. 6
  582.  
  583. Please direct all enhancement suggestions or bug reports to
  584.  
  585. David Garrison @ Novell  (DPD)
  586. 902 E. Live Oak
  587. Austin, TX  78704
  588.  
  589.  
  590.  
  591.  
  592.